﻿/*
* Copyright (c) 2010-2012 Tesla Engine Group
* 
* Permission is hereby granted, free of charge, to any person obtaining a copy
* of this software and associated documentation files (the "Software"), to deal
* in the Software without restriction, including without limitation the rights
* to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
* copies of the Software, and to permit persons to whom the Software is
* furnished to do so, subject to the following conditions:
* 
* The above copyright notice and this permission notice shall be included in
* all copies or substantial portions of the Software.
* 
* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
* IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
* FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
* AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
* LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
* OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
* THE SOFTWARE.
*/


namespace Tesla.Graphics {
    /// <summary>
    /// Enumeration of supported LightLogic parameters.
    /// </summary>
    public enum LightParameter {
        /// <summary>
        /// Binds a global ambient parameter.
        /// </summary>
        GlobalAmbient,
        /// <summary>
        /// Binds an array of light structs.
        /// </summary>
        LightList,
        /// <summary>
        /// Binds a parameter that denotes number of lights.
        /// </summary>
        LightCount
    }

    /// <summary>
    /// Specifies the projection mode for a Camera.
    /// </summary>
    public enum ProjectionMode {
        /// <summary>
        /// Indiciates the camera should use a perspective projection.
        /// </summary>
        Perspective,
        /// <summary>
        /// Indicates the camera should use an orthographic projection.
        /// </summary>
        Orthographic
    }

    /// <summary>
    /// Render bucket type for how the engine organizes and sorts geometry with the render queue.
    /// </summary>
    public enum RenderBucketType {
        /// <summary>
        /// Default, let the engine best decide. If not explicitly set, usually Opaque.
        /// </summary>
        Default,
        /// <summary>
        /// Geometry guaranteed to be rendered first, sorted by material and/or front-to-back.
        /// </summary>
        PreBucket,
        /// <summary>
        /// TODO (Placeholder)
        /// </summary>
        Shadow,
        /// <summary>
        /// Geometry that is opaque, sorted by material and/or front-to-back.
        /// </summary>
        Opaque,
        /// <summary>
        /// Transparenty geometry, sorted back-to-front. May render geometry in 1-2 passes.
        /// </summary>
        Transparent,
        /// <summary>
        /// Geometry that should be rendered with an orthographic projection. Sorted by IRenderable.OrthoOrder
        /// </summary>
        Ortho,
        /// <summary>
        /// Geometry that is guarnateed to be rendered last, sorted by material and/or front-to-back.
        /// </summary>
        PostBucket,
        /// <summary>
        /// Do not use the render queue, render immediately to the screen.
        /// </summary>
        Skip
    }

    /// <summary>
    /// Transparency type for how the engine will render transparent geometry.
    /// </summary>
    public enum TransparencyType {
        /// <summary>
        /// Default, let the engine decide. If not explicitly set, usually OneSided.
        /// </summary>
        Default,
        /// <summary>
        /// Only the front of a renderable should be rendered (single pass).
        /// </summary>
        OneSided,
        /// <summary>
        /// Both the front and back of the renderable should be rendered (two pass).
        /// </summary>
        TwoSided
    }

    /// <summary>
    /// Enumeration of supported types of lights.
    /// </summary>
    public enum LightType {
        /// <summary>
        /// Omni-directional light with a position in space.
        /// </summary>
        Point,
        /// <summary>
        /// Light with a position in space that emits light in a cone.
        /// </summary>
        Spot,
        /// <summary>
        /// Light that represents a source infinitely away and is purely
        /// directional based.
        /// </summary>
        Directional,
        /// <summary>
        /// Custom light defined by the user.
        /// </summary>
        Custom
    }
}
